particleengine

Class IEmitter

java.lang.Object

particleengine.IEmitter

Direct Known Subclasses:

BaseIEmitter, Emitter

public abstract class IEmitter
extends java.lang.Object

Emitter interface. Extend to make custom particle emitters.

Constructor Summary

Constructors

Constructor and Description
IEmitter()

Method Summary

Methods

Modifier and Type	Method and Description
void	disableDynamicAnchoring()
void	enableDynamicAnchoring() Sets a flag that will allow particles generated by this emitter to dynamically follow its motion.
abstract int	getBlendDestinationFactor()
abstract int	getBlendFunc()
abstract int	getBlendSourceFactor()
abstract com.fs.starfarer.api.combat.CombatEngineLayers	getLayer()
abstract org.lwjgl.util.vector.Vector2f	getLocation()
abstract float	getRenderRadius()
abstract com.fs.starfarer.api.graphics.SpriteAPI	getSprite()
abstract float	getXDir()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IEmitter

public IEmitter()

Method Detail

getLocation

public abstract org.lwjgl.util.vector.Vector2f getLocation()

Returns:

Absolute location of this emitter, in world coordinates.

getSprite

public abstract com.fs.starfarer.api.graphics.SpriteAPI getSprite()

Returns:

Sprite that particles from this emitter will have. Can be null, in which a default particle will be used.

getXDir

public abstract float getXDir()

Returns:

Angle, in degrees, that this emitter's x-axis faces. If 0, then this emitter's axes coincides with global axes (x-axis facing to the right).

getBlendSourceFactor

public abstract int getBlendSourceFactor()

Returns:

Source blend factor, e.g. GL11.GL_SRC_ALPHA.

getBlendDestinationFactor

public abstract int getBlendDestinationFactor()

Returns:

Destination blend factor, e.g. GL11.GL_ONE_MINUS_SRC_ALPHA.

getBlendFunc

public abstract int getBlendFunc()

Returns:

Blending operation, e.g. GL14.GL_FUNC_ADD.

getLayer

public abstract com.fs.starfarer.api.combat.CombatEngineLayers getLayer()

Returns:

Layer particles should be rendered on.

getRenderRadius

public abstract float getRenderRadius()

Returns:

Distance from edge of screen beyond which particles are culled before generation. This applies to the emitter's location rather than individual particles' locations.

enableDynamicAnchoring

public final void enableDynamicAnchoring()

Sets a flag that will allow particles generated by this emitter to dynamically follow its motion.

disableDynamicAnchoring

public final void disableDynamicAnchoring()